API Documentation
Public Member Functions | List of all members
nkInputs::MouseDevice Class Reference

A mouse device. More...

Public Member Functions

 MouseDevice ()
 
virtual ~MouseDevice ()
 
virtual int getX () const
 
virtual int getY () const
 
virtual long getLastXMovement () const
 
virtual long getLastYMovement () const
 
virtual long getLastZMovement () const
 
virtual bool getLeftButton () const
 
virtual bool getRightButton () const
 
virtual void updateDevice ()
 
virtual void recomputeMousePos ()
 

Detailed Description

A mouse device.

Constructor & Destructor Documentation

◆ MouseDevice()

nkInputs::MouseDevice::MouseDevice ( )

Constructor.

◆ ~MouseDevice()

virtual nkInputs::MouseDevice::~MouseDevice ( )
virtual

Destructor.

Member Function Documentation

◆ getX()

virtual int nkInputs::MouseDevice::getX ( ) const
virtual
Returns
Current x coordinate on screen.

◆ getY()

virtual int nkInputs::MouseDevice::getY ( ) const
virtual
Returns
Current y coordinate on screen.

◆ getLastXMovement()

virtual long nkInputs::MouseDevice::getLastXMovement ( ) const
virtual
Returns
The last delta on the x axis.

◆ getLastYMovement()

virtual long nkInputs::MouseDevice::getLastYMovement ( ) const
virtual
Returns
The last delta on the y axis.

◆ getLastZMovement()

virtual long nkInputs::MouseDevice::getLastZMovement ( ) const
virtual
Returns
The last delta on the z axis (wheel).

◆ getLeftButton()

virtual bool nkInputs::MouseDevice::getLeftButton ( ) const
virtual
Returns
Whether the left button is down (true) or not (false).

◆ getRightButton()

virtual bool nkInputs::MouseDevice::getRightButton ( ) const
virtual
Returns
Whether the right button is down (true) or not (false).

◆ updateDevice()

virtual void nkInputs::MouseDevice::updateDevice ( )
virtual

Updates the device's internal tracking memory.

◆ recomputeMousePos()

virtual void nkInputs::MouseDevice::recomputeMousePos ( )
virtual

Recomputes the mouse position on screen. Called during update.


The documentation for this class was generated from the following file: